Dimension.java

/**
 * @brief x lib is the library which includes the commonly used functions in 3 Sided Cube Android applications
 *
 * @author Callum Taylor
 **/
package in.lib.utils;

import android.content.Context;
import android.util.DisplayMetrics;
import android.view.Display;
import android.view.WindowManager;

/**
 * @brief Calculates the dimension value
 * @TODO Add support for orientation detection on width/height ratios
 */
public class Dimension
{
	private final DisplayMetrics mDM;
	private float mRatioWidth, mRatioHeight;

	/**
	 * The default constructor
	 *
	 * @param context
	 *            The activity context
	 */
	public Dimension(Context context)
	{
		mDM = new DisplayMetrics();
		WindowManager window = (WindowManager)context.getSystemService(Context.WINDOW_SERVICE);
		Display display = window.getDefaultDisplay();
		display.getMetrics(mDM);

		mRatioWidth = getScreenWidth() / 480.0f;
		mRatioHeight = getScreenHeight() / 800.0f;
	}

	/**
	 * Sets the ratio for the conversion based on the screen width/height
	 *
	 * @param width
	 *            The width of the desired ratio
	 * @param height
	 *            The height of the desired ratio
	 */
	public void setRatio(int width, int height)
	{
		mRatioWidth = (float)getScreenWidth() / width;
		mRatioHeight = (float)getScreenHeight() / height;
	}

	/**
	 * Get the calculated width of the ratio and desired width based on the
	 * screen width
	 *
	 * @param width
	 *            The original width
	 * @return The new width calculated
	 */
	public float getWidthFromRatio(int width)
	{
		return mRatioWidth * width;
	}

	/**
	 * Get the calculated height of the ratio and desired height based on the
	 * screen width
	 *
	 * @param height
	 *            The original height
	 * @return The new height calculated
	 */
	public float getHeightFromRatio(int height)
	{
		return mRatioHeight * height;
	}

	/**
	 * Get the width value from a screen percentage (0 - 100%)
	 *
	 * @param percent
	 *            The amount of the screen in percentage from 0 to 100
	 * @return The size in px of the screen from the given percentage
	 */
	public int getPercentageWidthValue(int percent)
	{
		return (int)((percent / 100.0f) * mDM.widthPixels);
	}

	/**
	 * Get the height value from a screen percentage (0 - 100%)
	 *
	 * @param percent
	 *            The amount of the screen in percentage from 0 to 100
	 * @return The size in px of the screen from the given percentage
	 */
	public int getPercentageHeightValue(int percent)
	{
		return (int)((percent / 100.0f) * mDM.heightPixels);
	}

	/**
	 * Get the width value from a screen percentage (0.0f - 1.0f)
	 *
	 * @param percent
	 *            The amount of the screen in percentage from 0.0f to 1.0f
	 * @return The size in px of the screen from the given percentage
	 */
	public float getPercentageWidthValue(float percent)
	{
		return (percent) * mDM.widthPixels;
	}

	/**
	 * Get the height value from a screen percentage (0.0f - 1.0f)
	 *
	 * @param percent
	 *            The amount of the screen in percentage from 0.0f to 1.0f
	 * @return The size in px of the screen from the given percentage
	 */
	public float getPercentageHeightValue(float percent)
	{
		return (percent) * mDM.heightPixels;
	}

	/**
	 * Calculates the percentage of the size relative to the screen
	 *
	 * @param width
	 *            The given width
	 * @return The percentage value of the width
	 */
	public float getCalculatedPerecentageFromWidth(int width)
	{
		return (1.0f / (mDM.widthPixels / width));
	}

	/**
	 * Calculate the dp value from pixels
	 *
	 * @param px
	 *            The input pixel size
	 * @return The size in dp
	 */
	public int densityPixelInverse(int px)
	{
		int pixels = (int)(px * (1.0f / mDM.density));

		return pixels;
	}

	/**
	 * Calculate the pixel value from density pixels
	 *
	 * @param dp
	 *            The input density pixel value
	 * @return The converted pixel value
	 */
	public int densityPixel(int dp)
	{
		int pixels = (int)(dp * mDM.density);

		return pixels;
	}

	/**
	 * Gets the screen width of the activity
	 *
	 * @return Screen Width
	 */
	public int getScreenWidth()
	{
		return mDM.widthPixels;
	}

	/**
	 * Gets the screen height of the activity
	 *
	 * @return Screen Height
	 */
	public int getScreenHeight()
	{
		return mDM.heightPixels;
	}

	/**
	 * Gets the screen density of the activity
	 *
	 * @return Screen Density
	 */
	public float getScreenDensity()
	{
		return mDM.density;
	}

	/**
	 * Gets the value of the density
	 *
	 * @return The screen density expressed as dots-per-inch. May be either
	 *         DisplayMetrics.DENSITY_LOW, DisplayMetrics.DENSITY_MEDIUM, or
	 *         DisplayMetrics.DENSITY_HIGH.
	 */
	public int getDensityName()
	{
		return mDM.densityDpi;
	}
}